adTempus API
PreviousUpNext
IScheduler::GetDescriptionForObject Method

Gets a user-friendly description of the object with the specified OID.

C++
HRESULT GetDescriptionForObject(BSTR objectOID, BSTR targetComputer, [out,retval] BSTR * objectDescription);
C#
GetDescriptionForObject(String objectOID, String targetComputer, [out,retval] BSTR objectDescription);
Visual Basic
Sub GetDescriptionForObject(objectOID As String, targetComputer As String, objectDescription As [out,retval] BSTR)
Parameters 
Description 
[in] BSTR objectOID 
The OID of the object to describe. 
[in] BSTR targetComputer 
The remote server on which the object is located. 
[out,retval] BSTR * objectDescription 
On successful return, contains a description of the object 

This method is used to get a description of an object on a remote server, without the need for the client to establish a connection to that server. 

When you call GetDescriptionForObject, the server to which the client is connected attempts to connect to the specified remote server and get a description for the object by calling IADTObejct::GetDescription.

adTempus API Reference version 3.0.0.0, revised 10/30/2008